<html lang="en-US">

<head>
    
<title>上帝视角看 “Go 项目标准布局” 之争 - 花落雨忧</title>

<meta property="og:title" content="上帝视角看 “Go 项目标准布局” 之争 - 花落雨忧">



    



    
    <meta property="description" content="大家好，我是煎鱼。
前段时间 Go 语言社区有一件事情引爆了热议，那就是 golang-standards/project-layout 项目的 “Go 项目的标准布局” 之争。
没想到，五一假期，认真一看，这个 issues 已经提出将近一个月了，仍然在热议阶段，我想，咱们需要好好的聊聊这个话题。
煎鱼带你了解下的前因后果，再分享我的看法和业务真实情况。
[&amp;hellip;] 在 GitHub  &amp;hellip;">
    <meta property="og:description" content="大家好，我是煎鱼。
前段时间 Go 语言社区有一件事情引爆了热议，那就是 golang-standards/project-layout 项目的 “Go 项目的标准布局” 之争。
没想到，五一假期，认真一看，这个 issues 已经提出将近一个月了，仍然在热议阶段，我想，咱们需要好好的聊聊这个话题。
煎鱼带你了解下的前因后果，再分享我的看法和业务真实情况。
[&amp;hellip;] 在 GitHub  &amp;hellip;">
    






<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1">

<link rel="shortcut icon" href="https://www.lican.site/logo/logo.png" type="image/x-icon" />



<link rel="stylesheet" href="/css/style.min.css" />

<link rel="stylesheet" href="/css/reset.min.css" />




<script src="https://www.lican.site/js/highlight.min.js"></script>

<script>
hljs.configure({ ignoreUnescapedHTML: true })
hljs.highlightAll();
</script>


<script src="https://www.lican.site/js/jquery.min.js"></script>




<link href="https://www.lican.site/css/hugo-code.min.css" rel="stylesheet" />



    <style>
        .post-content img {
            max-width: 400px;
        }
    </style>
</head>

<body id="period" class="home blog">
    <a class="skip-content" href="#main">Press "Enter" to skip to content</a>
    <div id="overflow-container" class="overflow-container">
        <header class="site-header" id="site-header" role="banner">
    <div class="max-width">
        <div id="title-container" class="title-container">
            <div id="site-title" class="site-title"><a href="/">花落雨忧</a></div>
            <p class="tagline">思所及 力所行 方为真.</p>
        </div>
        
        <div id="menu-primary-container" class="menu-primary-container">
            <div class="icon-container">
            </div>
            <div id="menu-primary" class="menu-container menu-primary" role="navigation">
                <nav class="menu">
                    <ul id="menu-primary-items" class="menu-primary-items">
                        
                        
                        <li id="menu-item-0"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/posts" aria-current="page" tabindex="0">首页</a></li>
                        
                        <li id="menu-item-1"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/tech/" aria-current="page" tabindex="1">技术文档</a></li>
                        
                        <li id="menu-item-2"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/article/" aria-current="page" tabindex="2">文章</a></li>
                        
                        <li id="menu-item-3"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/project/" aria-current="page" tabindex="3">项目</a></li>
                        
                        <li id="menu-item-4"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/about/" aria-current="page" tabindex="4">关于</a></li>
                        
                    </ul>
                </nav>
            </div>
        </div>
    </div>
</header>
        <div id="primary-container" class="primary-container">
            <div class="max-width">
                <section id="main" class="main" role="main">
                    <div id="loop-container" class="loop-container">
                        <div
                            class="post type-post status-publish format-standard hentry entry">
                            <article>
                                <div class="post-container">
                                    <div class="post-header">
                                        <h2 class="post-title">
                                            <a href="/posts/go/go-standards/">上帝视角看 “Go 项目标准布局” 之争</a>
                                        </h2>
                                        
                                        <div class="post-byline">Published on
                                            <a class="date" href="javascript:;">2021/09/13</a>
                                            
                                            
                                            
                                            
                                            
                                        
                                    </div>
                                    <div class="post-content">
                                        <p>大家好，我是煎鱼。</p>
<p>前段时间 Go 语言社区有一件事情引爆了热议，那就是 <code>golang-standards/project-layout</code> 项目的 “Go 项目的标准布局” 之争。</p>
<p>没想到，五一假期，认真一看，这个 issues 已经提出将近一个月了，仍然在热议阶段，我想，咱们需要好好的聊聊这个话题。</p>
<p>煎鱼带你了解下的前因后果，再分享我的看法和业务真实情况。</p>
<h2 id="背景">背景</h2>
<h3 id="问题发生地">问题发生地</h3>
<p>在 GitHub 上有一个项目 Spaghetti（github.com/adonovan/spaghetti），是 Go 软件包的一个依赖性分析工具。</p>
<p>该项目的目录结构如下：</p>
<p><img src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/11b7f74aa3944e509c89bcbfc51a2c99~tplv-k3u1fbpfcp-zoom-1.image" alt="图片"></p>
<p>看上去并不复杂，代码量不多，文件平铺也不超过一屏，就是一个布局比较简单的项目。</p>
<p>有一位老哥提出了一个 PR，明确的期望该项目按照 <code>golang-standards/project-layout</code> 项目给出的 “标准” 布局来调整。：</p>
<p><img src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/e0da59130ce94ee190d51491396d6919~tplv-k3u1fbpfcp-zoom-1.image" alt="图片"></p>
<p>我猜测该项目可能是因为把 Go、HTML、JS、PNG 和 go.mod 文件等摆在了一起，引起了该同学的一丝丝纠结，觉得比较乱？</p>
<h3 id="标准布局-长什么样子">“标准布局“ 长什么样子</h3>
<p>在 <code>golang-standards/project-layout</code> 项目中，其自称：</p>
<p><img src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/55511ceb43cb48c59d0ce302783eec59~tplv-k3u1fbpfcp-zoom-1.image" alt="图片"></p>
<p>项目的组织名也是 &ldquo;golang-standards&rdquo;，其提供了一个基本的 Go 项目布局，精简展示如下：</p>
<pre><code>project-layout
├── api
├── cmd
├── configs
├── docs
├── go.mod
├── init
├── internal
├── pkg
├── scripts
├── vendor
├── ...

</code></pre><ul>
<li>
<p>/cmd：项目主要的应用程序。</p>
</li>
<li>
<p>/internal：私有的应用程序代码库，这些是不希望被其他人导入的代码。</p>
</li>
<li>
<p>应用程序实际的代码可以放在 /internal/app 目录（如：internal/app/myapp）。</p>
</li>
<li>
<p>应用程序的共享代码放在 /internal/pkg 目录（如：internal/pkg/myprivlib）中。</p>
</li>
<li>
<p>/pkg：外部应用程序可以使用的库代码（如：/pkg/mypubliclib）。其他项目将会导入这些库来保证项目可以正常运行。</p>
</li>
<li>
<p>/vendor：应用程序的依赖关系，可通过执行 <code>go mod vendor</code> 执行得到。</p>
</li>
<li>
<p>/configs：配置文件模板或默认配置。</p>
</li>
<li>
<p>/init：系统初始化（systemd、upstart、sysv）和进程管理（runit、supervisord）配置。</p>
</li>
<li>
<p>/scripts:：用于执行各种构建，安装，分析等操作的脚本。</p>
</li>
</ul>
<p>更具体的布局介绍，大家可以参见 project-layout 项目的 README，其基本把方方面面的目录都考虑到了（人多力量大）。</p>
<p>由于内容过于长，因此就不一一展示了。</p>
<h3 id="russ-cox-现身原因">Russ Cox 现身原因</h3>
<p>不过很巧，该项目的作者是前 Google 员工，是 <code>gopl.io</code> 项目（5.1k stars）的作者。</p>
<p>在仅仅过去 23 分钟后，作为 GoTeam Leader 的 Russ Cox（@rsc）就现身，并提出新的 issue 表达出了反对意见：</p>
<p><img src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/f72fcd999116477193c22430eb33c22f~tplv-k3u1fbpfcp-zoom-1.image" alt="图片"></p>
<p>在 <code>golang-standards/project-layout</code> 项目的 README 中有明确指出这不是官方的标准，有如下声称：</p>
<blockquote>
<blockquote>
<p>it is a set of common historical and emerging project layout patterns in the Go ecosystem.</p>
</blockquote>
</blockquote>
<p>Russ Cox 主要是对声称 &ldquo;这是一套 Go 生态系统中常见的历史和新兴的项目布局模式&rdquo; 这一说法表示了 “不准确” 的意见。</p>
<p>例如：Go 生态系统中的绝大多数包都不会将可导入的包放在 pkg 子目录中。更广泛地说，这里描述的只是非常复杂的工程项目，而 Go 的仓库往往要简单得多。</p>
<p>另外，不幸的是，这套项目布局在组织名字上被称作 &ldquo;golang-standards&rdquo;（Golang 标准） 提出来，实际上并非真的是官方标准，有误导的情况存在。</p>
<h3 id="russ-cox-反对原因">Russ Cox 反对原因</h3>
<p>在了解 project-layout 项目所提供的 “标准“ 项目布局和 Russ Cox 提出 issues 的背景后。</p>
<p>我们进一步了解 Russ Cox 认为<strong>这不对</strong>的根本考虑。project-layout 这个项目有两个问题：</p>
<ul>
<li>
<p>它声称是 Go 标准（Go standards）的主办方，但实际上并非如此，因为这些标准绝非 Go 官方标准。</p>
</li>
<li>
<p>它提出的项目布局标准过于复杂，不是一个合理的标准。</p>
</li>
</ul>
<h2 id="go-项目布局的标准是什么">Go 项目布局的标准是什么</h2>
<p>提出这个 issues 后，出现了一大堆人追问 Russ Cox，到底何为 Go 项目的布局标准？</p>
<p>Russ Cox 给出了正式回应，一个可导入的 Go repo 的最小标准布局是：</p>
<ul>
<li>
<p>在你的根目录下放一个 LICENSE 文件。</p>
</li>
<li>
<p>在你的根目录下放一个 go.mod 文件。</p>
</li>
<li>
<p>将 Go 代码放在 repo 中，放在根目录中，或者按照你认为合适的方式组织成一个目录树。</p>
</li>
</ul>
<p>就这样了，这就是 &ldquo;标准&rdquo;，没有那么复杂。不需要像 project-layout 项目一样的布局。像是 Go 官方的 <code>golang.org/x</code> 仓库打破了 project-layout 所说的这些 &ldquo;规则 &ldquo;中的每一条。</p>
<h2 id="go-提案">Go 提案</h2>
<p>在经历了长时间的口水战后，已经有人在 Go 官方仓库提出希望释出相关的提案（proposal）：</p>
<p><img src="https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ada96a8647e04b38a340995ccf764156~tplv-k3u1fbpfcp-zoom-1.image" alt="图片"></p>
<p>猜测可能会有如下几种可能：</p>
<ul>
<li>
<p>GitHub 项目 golang-standards/project-layout 愿意更名，不再自称 ”golang-standards“，不过可能性比较低，因为已经已多人提出，但作者没什么表示。</p>
</li>
<li>
<p>Go 官方正式提供 Go 标准项目布局的说明。</p>
</li>
<li>
<p>Go 官方不做约束，仅做表态，可能输出文章。</p>
</li>
</ul>
<p>后续大家继续关注该提案，就可以知道发展了，传送门：issues #45861。</p>
<p>按照惯例，我猜测第三种可能性最大，因为很难有人可以提供所有开发者认可的标准，每个事业部、团队的喜好都可能有所不同。</p>
<h2 id="总结">总结</h2>
<p>实际上，任何东西自称 “XX 标准”，在名气大后，都会带来一些问题。就像本文提到的 golang-standards/project-layout 项目一样。</p>
<p>换位思考一下，若你是某个项目的 Leader，某一天你的同事，被人拿着 “标准” 来建议修改时，说这是这个项目的 “标准”，会不会很奇妙？</p>
<p>无独有偶，我有一个朋友，他们公司早年只有一套 DDD 标准，本想统一。结果后面每一个介入 DDD 的业务同学，都认为前人不标准，每个人都自创了一套 DDD 标准。</p>
<p>总是会有小伙伴<strong>想让定义绝对的 “标准”，又或是 “最佳实践”</strong>。其实是难以定义的，最好的就是能够一个团队内形成基本共识，这里面牵扯到的不单单只有技术&hellip;</p>
<p>你对此有什么看法呢，<strong>欢迎在评论区留言和大家一起交流</strong>！</p>


                                        
                                        
                                        
                                        <div class="rp4wp-related-posts">
                                            <h3>相关文章</h3>
                                            <ul>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/go-map-access/">用 Go map 要注意这个细节，避免依赖他！</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/go-errors-boom/">生产环境遇到一个 Go 问题，整组人都懵逼了...</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/gmp-why-p/">经典面试题：你觉得 Go 在什么时候会抢占 P？</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/go-empty-struct/">用 Go struct 不能犯的一个低级错误！</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/go-bootstrap0/">详解 Go 程序的启动流程，你知道 g0，m0 是什么吗？</a>
                                                    </div>
                                                </li>
                                                
                                            </ul>
                                        </div>
                                        
                                        
                                    </div>

                                    
                                    
                                    

                                    
                                    <div class="post-meta">
                                        
                                        
                                        <div class="post-tags">
                                            <ul>
                                            
                                            <li>
                                                <a href="/tags/go" title="View all posts tagged match">go</a>
                                            </li>
                                            
                                            </ul>
                                        </div>
                                        
                                        
                                        <nav class="further-reading">
                                            
                                            <div class="previous">
                                                <span>&lt;&lt; Prev</span>
                                                <a href="https://www.lican.site/posts/go/go-map-access/"
                                                    rel="prev">用 Go map 要注意这个细节，避免依赖他！</a> </div>
                                            
                                            
                                            <div class="next">
                                                <span>Next >></span>
                                                <a href="https://www.lican.site/posts/go/go-array-slice/">Go 数组比切片好在哪？</a> 
                                            </div>
                                            
                                        </nav>
                                    </div>
                                    
                                    

                                    
                                    
                                    

                                </div>
                            </article>
                        </div>
                    </div>
                </section>
                <aside class="sidebar sidebar-primary" id="sidebar-primary" role="complementary">
    <h1 class="screen-reader-text">Sidebar</h1>
    

    
    
    <section id="text-2" class="widget widget_text">
        <div class="textwidget">
            
            <div id="profile">
                <div id="profile_picture"><img src="https://www.lican.site/logo/logo.png"></div>
                <div id="profile_intro">
                    <p><span class="name">Lican</span></p>
                    <p class="intro">全栈开发者，爱好造轮子。</p>
                </div>
            </div>
            
            <p>
                <script type="text/javascript">
                    (function ($) {
                        $(document).ready(function () {
                            var menuPrimaryContainer = $('#menu-primary-container');
                            var profile = $('#text-2');
                            $('#toggle-navigation').click(function () {
                                if (menuPrimaryContainer.hasClass('open')) {
                                    profile.removeClass('open');
                                } else {
                                    profile.addClass('open');
                                }
                            });
                        });
                    })(jQuery);
                </script>
            </p>
        </div>
    </section>
    
    
    
    
    
    <section id="text-5" class="widget widget_text">
        <h2 class="widget-title">开源项目</h2>
        <div class="textwidget">
            <div id="projects" style="line-height: 22px;">
                
                <a href="https://github.com/idoubi/gonews"
                    target="_blank">gonews</a>: &nbsp;Daily news for golang<br>
                
                <a href="https://github.com/idoubi/sql2struct"
                    target="_blank">sql2struct</a>: &nbsp;Generate go struct according to SQL<br>
                
                <a href="https://github.com/idoubi/goz"
                    target="_blank">goz</a>: &nbsp;Request library used in golang<br>
                
        </div>
    </section>
    
    

    
    
    
    
    

    
    
    

    
    
    

    
    
    
    
</aside>
            </div>
        </div>

        <footer id="site-footer" class="site-footer" role="contentinfo">
    <div class="max-width">
    </div>
    <div class="footer">
        <div id="footercontent">
            © lican.vip All rights reserved<br/>
            Built with Hugo Theme <a href="https://github.com/idoubi/hugo-theme-period" target="_blank">Period</a>
        </div>
    </div>
</footer>

<script>
    var _hmt = _hmt || [];
    (function() {
      var hm = document.createElement("script");
      hm.src = "https://hm.baidu.com/hm.js?e8351b6d4626d5881d439ea1f6184baa";
      var s = document.getElementsByTagName("script")[0]; 
      s.parentNode.insertBefore(hm, s);
    })();
</script>
    
    
    </div>
    
</body>

</html>